/**

This file is part of MaCI/GIMnet.

MaCI/GIMnet is free software: you can redistribute it and/or modify it 
under the terms of the GNU Lesser General Public License as published 
by the Free Software Foundation, either version 3 of the License, or 
(at your option) any later version.

MaCI/GIMnet is distributed in the hope that it will be useful, but WITHOUT 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public 
License for more details.

You should have received a copy of the GNU Lesser General Public 
License along with GIMnet. (See COPYING.LESSER) If not, see 
<http://www.gnu.org/licenses/>.

**/
/**
 * \file
 * \brief Example client for building MaCI Clients apps. (With Dummy interface)
 * \author Antti Maula <antti.maula@tkk.fi>
 *
 * $Id: DummyClientExample.cpp,v 1.4 2009-08-12 12:17:27 morsko Exp $
 *
 */
#include <stdio.h>
#include <stdlib.h>
#include <signal.h>
#include <stdlib.h>
#include <string>
#include "ownutils.h"
#include "binbag.h"
#include "DummyClient.hpp"

#ifdef WINDOWS_OS
#include <getopt.h>
#endif

//*****************************************************************************
// Include GIMI in proper way
#define GIMI_CLIENT_API (20000)
#include "gimi.h"
//*****************************************************************************
// Set initial verbosity level to 1
static int verbose = 1;
//*****************************************************************************
// Choose your namespace
using namespace MaCI;
using namespace MaCI::Dummy;
//*****************************************************************************
// Running?
static volatile bool run = true;
static ownThreadHandle signalHandlerThread;
//*****************************************************************************
static std::string datasource;
static std::string datasourceMaCISL;
//*****************************************************************************
//*****************************************************************************
// Example for using the callback.
class CDummyClientCallbackExample : public MaCI::Dummy::CDummyClientCallback
{
public:
  CDummyClientCallbackExample() {
  }

  ~CDummyClientCallbackExample() {
  }
protected:
  void OnDummyDataEvent(const CDummyData &aData,
                        const unsigned int aDataSequence,
                        CDummyClient &aDummyClient) {
    dPrint(2,"Got DummyDataEvent %u through callback from Client %p:",
           aDataSequence, &aDummyClient);
    aData.Print(3);
  }
};
//*****************************************************************************
//*****************************************************************************
//*****************************************************************************
#ifdef LINUX_OS
static int SignalHandlerThread(void *)
{
  dPrint(8, "Signal handler thread (%ld) starting...", pthread_self());

  while (run) {
    // Now, wait for requested signals to arrive
    int sig;
    sigset_t mask;
    sigemptyset(&mask);
    sigaddset(&mask, SIGINT);
    sigaddset(&mask, SIGTERM);
    sigaddset(&mask, SIGPIPE);
    sigaddset(&mask, SIGHUP);
    sigwait(&mask, &sig);

    // Got signal, sigwait returned!
    dPrint(1,"Got Signal '%d' (%s)", sig, strsignal(sig));

    // What to do?
    switch(sig) {
    case SIGINT:
    case SIGTERM:
    case SIGPIPE:
    case SIGHUP:
      run = false;
      ownSleep_ms(1000);
      break;

    default:
      dPrint(1,"Unhandled signal! Ignore!");
      break;
    }
  }
  return 0;
}
//*****************************************************************************

static void InitSignalHandler(void)
{
  // Now; Set to BLOCK ALL SIGNALS
  sigset_t mask;
  sigemptyset(&mask);
  sigaddset(&mask, SIGINT);
  sigaddset(&mask, SIGTERM);
  sigaddset(&mask, SIGPIPE);
  sigaddset(&mask, SIGHUP);
  pthread_sigmask(SIG_BLOCK, &mask, NULL);

  // Start signal handler thread
  signalHandlerThread = ownThread_Create((void*)SignalHandlerThread, NULL);
}
#endif
//*****************************************************************************
//*****************************************************************************

/**
 * All MaCI modules should support these parameters with exactly these names
 * *** DO NOT CHANGE NOR DELETE ANY OF THEM ***
 * Howevery, feel free to add new parameters as you wish.
 */
static void showUsage()
{
  fprintf(stderr,"\n");
  fprintf(stderr,"Usage:\tDummyClientExample [OPTIONS]\n");
  fprintf(stderr,"  [-u addr]\t\t\tUse 'addr' as GIMnet AccessPoints address\n");
  fprintf(stderr,"  [-p port]\t\t\tUse 'port' as GIMnet AccessPoints port\n");
  fprintf(stderr,"  [-n name]\t\t\tUse 'name' as this nodes GIMnet name\n");
  fprintf(stderr,"  [-s name]\t\t\tSpecify the data source\n");
  fprintf(stderr,"  \t\t\t\tOR\n");
  fprintf(stderr,"  [-S name]\t\t\tSpecify the data source by MaCISL\n\n");

  fprintf(stderr,"  [-v]\t\t\t\tIncrease verbosity by 1\n");
  fprintf(stderr,"  [-q]\t\t\t\tQuiet mode\n");
  fprintf(stderr, "\n\n");
}
//*****************************************************************************

static int dummyWatch(CDummyClient *dc)
{
  CDummyData dd;
  bool r;
  unsigned int sequence = 0;
  while(run) {

    r = dc->GetDummyEvent(dd, &sequence, 5000);
    if (r) {
      dPrint(1,"Got event:");
      dd.Print(1);
    }
  }

  return 0;
}
//*****************************************************************************

static int ExecuteExampleClient(gimi::GIMI &g)
{
  // Dummy client instance

#ifdef USE_STANDALONE_GIMI_INSTANCE
#warning Using standalone GIMI instance (USE_STANDALONE_GIMI_INSTANCE)
  // If this constant is defined, the example Execute uses the format
  // not dependant on the GIMI session. Without this constant, the
  // preconnected GIMI from the parameter list is used. As the GIMI
  // instances are independent, the client has two connection to
  // GIMnet when using this example.
  EMaCIError eme;
  CDummyClient dc(NULL, 0);

  // **************************************************************************
  // **** This is an EXAMPLE sequence, it makes no sense in any way :)

  // Connect.
  eme = dc.CreateGIMnetConnection("asrobo.hut.fi", 40002);
  assert(eme == KMaCIOK);

  // Test to Destroy. (Soon we'll reconnect again)
  eme = dc.DestroyGIMnetConnection();
  assert(eme == KMaCIOK);

  // Connect (and leave it connected, allowing normal tests to run)
  eme = dc.CreateGIMnetConnection("asrobo.hut.fi", 40002);
  assert(eme == KMaCIOK);

#else
  // Traditional form, where the GIMI is given as preconnected pointer
  // to the DummyClient instance.
  CDummyClient dc(&g, 0);

#endif

  // Dummy data instance
  CDummyData dd;
  dd.CreateInternalBinBag();

  //Alarm client callback example
  CDummyClientCallbackExample dcce;
  // Variable for storing thread id.
  ownThreadHandle dummyWatchThread;

  // Init random generator.
  ownRandom_init_time();


  // Assign default target.
  if (datasource.size()) {
    dc.SetDefaultTarget(datasource);

  } else {
    // GIMI is Open(), so we can execute this.
    MaCICtrl::SMaCISL sl(datasourceMaCISL);
    if (sl.IsValidFQMaCISL()) {
      dc.SetDefaultTarget(sl, 10000);
    }

  }
  // Assign callback
  dc.SetDummyClientCallback(&dcce);

  // Open.
  if (dc.Open() == KMaCIOK) {
    dPrint(ODINFO,"Succesfully Open():ed DummyClient, BWT, you have connected to service: '%s'",
           dc.GetDefaultTargetMaCISL().ToMaCISLString().c_str());
    dummyWatchThread = ownThread_Create((void*)dummyWatch, &dc);

    while(run) {

      // Construct 'Command'
      const TCommand cmd(KCommandDoDummyThings, random());
      dd.SetCommand(cmd);

      // Send command to Server part.
      dc.SendCommand(dd);


      // Now do a synchronous call: his is by no means a proper place
      // to implement the feature, but is good for example purposes to
      // keep it simple (KISS-property is met). So; don't add
      // synchronous operation to the main loop, as it will block the
      // execution for timeout_ms.
      unsigned int rvalue = 0;
      ownTime_ms_t scallbegin = ownTime_get_ms();
      if (dc.GetRandomNumberBySynchronousCall(rvalue, 1000)) {
        dPrint(1,"Got value: '%u', total time of call was: %u milliseconds",
               rvalue, ownTime_get_ms_since(scallbegin));

      } else {
        dPrint(1,"WTF? Synchronous call failed? Server doesn't implement the feature or connection problems?");

      }


      // Do another example sync call, using the overloaded function
      // which waits for MULTIPLE replies. Take 10 values.
      rvalue = 0;
      scallbegin = ownTime_get_ms();
      std::vector<unsigned int> numbas;
      if (dc.GetRandomNumberBySynchronousCall(numbas, 10, 1000)) {
        for(EACH_IN_i(numbas)) {
          dPrint(1,"RandomValue: %d", *i);
        }

        dPrint(1,"Got all 10 values, total time of call was: %u milliseconds",
               ownTime_get_ms_since(scallbegin));

      } else {
        dPrint(1,"WTF? Synchronous call failed? Server doesn't implement the feature or connection problems?");

      }



      // Wait for a "moment".
      const unsigned int sleepTime = 1000 + random() % 5000;
      dPrint(1,"Sleeping for %u milliseconds...", sleepTime);
      ownSleep_ms(sleepTime);
    }


  } else {
    dPrint(1,"Failed to Open() DummyClient.");

  }


  return 0;
}
//*****************************************************************************

int main(int argc, char *argv[])
{
  // GIMnet parameters
  std::string gimnetAP = "asrobo.hut.fi";
  int gimnetAPPort = 40002;
  std::string gimnetName;

  // setup signal handling
#ifdef LINUX_OS
  InitSignalHandler();
#endif

  // Objects
  gimi::GIMI g;

  // Init Debug lib
  debugInit();
  debugSetGlobalDebugLvl(4);
  const std::string logfile = std::string(argv[0]) + ".log";
  debugSetLogFilename(logfile.c_str());

  // Greet
  fprintf(stderr,
	  "\n%s - $Revision: 1.4 $\n", argv[0]);

  /////////////////////////////////////////////////////////////////////////////
  // Parse parameters - Remember: ** DO NOT MODIFY OR DELETE ANY OF THIS **
  // _Add_ anything as you wish.
  /////////////////////////////////////////////////////////////////////////////
  bool parse = true;
  while(parse) {
    int c;
    c = getopt(argc, argv, "n:u:p:s:S:hqv");
    switch(c) {

      /////////////////////////////////
      ////// Application specific /////
      /////////////////////////////////

    case 's':
      datasource = optarg;
      dPrint(3,"Using DataSource '%s'", optarg);
      break;

    case 'S':
      datasourceMaCISL = optarg;
      dPrint(3,"Using DataSource MaCISL '%s'", optarg);
      break;

      /////////////////////////////////////////////////////////////////////////
      /// Add here anything you need.
      /////////////////////////////////////////////////////////////////////////

      /////////////////////////////////
      ///// MaCI/GIMnet parameters ////
      /////////////////////////////////
    case 'n':
      gimnetName = optarg;
      dPrint(3,"Using GIMnet Name '%s'", optarg);
      break;

    case 'u':
      gimnetAP = optarg;
      dPrint(3,"Using GIMnetAP address '%s'", optarg);
      break;

    case 'p':
      gimnetAPPort = atoi(optarg);
      dPrint(3,"Using GIMnetAP port '%d'", gimnetAPPort);
      break;

      //////////////////////////////////
      //// GENERIC:                 ////
      //////////////////////////////////
    case 'v':
      // Increase only if not previously set to 0 (by 'quiet')
      if (verbose > 0)
	debugSetGlobalDebugLvl(++verbose);
      break;

    case 'q':
      verbose = 0;
      debugSetGlobalDebugLvl(0);
      break;

    case 'h':
    case '?':
      showUsage();
      exit(1);
      break;

    case -1:
      parse = false;
      break;
    }
  }

  /////////////////////////////////////////////////////////////////////////////
  // Execute connection to GIMnet.
  /////////////////////////////////////////////////////////////////////////////
  int r;
  if ( (r = g.connectToHubEx(gimnetAP, gimnetAPPort, gimnetName) ) != GIMI_OK) {
    dPrint(1,"Failed to connect to GIMnet AccessPoint '%s:%d' with name '%s': '%s'",
	   gimnetAP.c_str(),
	   gimnetAPPort,
	   gimnetName.size()?gimnetName.c_str():"<anonymous>",
	   gimi::getGimiErrorString(r).c_str());

  } else {
    dPrint(2,"Succesfully connected to GIMnet at AccessPoint '%s:%d' with name '%s': '%s'",
	   gimnetAP.c_str(),
	   gimnetAPPort,
	   gimnetName.size()?gimnetName.c_str():"<anonymous>",
	   gimi::getGimiErrorString(r).c_str());

    // GIMnet connection OK, now execute module.
    r = ExecuteExampleClient(g);
  }

  return 0;
}
//*****************************************************************************
//*****************************************************************************
/******************************************************************************
 *
 * $Log: not supported by cvs2svn $
 * Revision 1.3  2009-05-13 07:18:15  amaula
 * Doxygens file tag parameter removed, as no parameter means 'document this file'
 *
 * Revision 1.2  2009-04-08 07:08:21  amaula
 * Merged in 'MaCI-examples-restructuring-branch'
 *
 * Revision 1.1.2.1  2009-03-20 09:15:29  amaula
 * Structural change part I
 *
 * Revision 1.8  2009-03-17 10:09:51  amaula
 * Fixed compile error.
 *
 * Revision 1.7  2009-03-11 09:23:46  amaula
 * More Dummy features.
 *
 * Revision 1.6  2009-02-13 08:38:00  amaula
 * Support for reading back the currently assigned MaCISL target.
 *
 * Revision 1.5  2009-02-10 12:33:00  amaula
 * Issue #0000093: client rajapinnan yksinkertaistus - Fixed
 *
 * Revision 1.4  2009-01-26 08:28:48  amaula
 * Merged in branch: 'MaCI-interfaces-implement-threadsafe-replyQueue-branch'
 *
 * Revision 1.3.2.2  2009-01-26 08:05:37  amaula
 * Some cleanups and notes.
 *
 * Revision 1.3.2.1  2009-01-23 13:58:50  amaula
 * Finally seems to work. Little more testing and then MERGE.
 *
 * Revision 1.3  2009-01-19 11:59:05  amaula
 * Merged in branch: 'MaCI-interfaces-synchronous-messaging-replyQueue-implementation-branch'
 *
 * Revision 1.2.4.1  2009-01-19 11:45:35  amaula
 * Example Implementation for Synchronous messages complete.
 *
 * Revision 1.2  2008-12-08 09:49:23  amaula
 * Dummy updated.
 *
 * Revision 1.1  2008-12-01 12:54:43  amaula
 * Added client for Dummy interface.
 *
 * Revision 1.5  2008-11-07 11:12:46  amaula
 * Lots of misc. changes.
 *
 *
 *
 *****************************************************************************/
//*****************************************************************************
//*****************************************************************************


